Skip to main content

itemData

Type

property

Summary

Sorted array with the list of images to load and their properties.

Syntax

get the itemData of <widget>
set the itemData of <widget> to <pImageListArray>

Description

Use the itemData property to set the list of images to be displayed in the widget. This property will create an ordered matrix which should have a structure like the following:

[{
\"img\" : \"./assets/image_001.png\",
\"title\": \"Big Blue Bear\",
\"icon\": \"Star\",
\"iconColor\": \"blue\"
},{
\"img\" : \"./assets/image_002.png\",
\"title\": \"moorea Pacific Ocean\",
\"icon\": \"star empty\",
\"iconColor\": \"255,255,255\"
},
...
]

Parameters

NameTypeDescription

pImageListArray

An ordered array where each key has the following structure:

  • image: A string that is a reference to the image file.
  • img: It is shorthand for the image key, so it is only used if the image key does not exist.
  • title: It is a string that will be displayed as the title of the item.
  • titleSize: Defines the size of the font used to display the title of the article.
  • titleStyle: Specifies the style or styles applied to the text in the title of the item.
  • titleFont: Specifies the font of the text of the item.
  • titleColor: Specifies the color of the text of the item.
  • titleAlign: Specifies the align applied to the text in the title of the item.
  • subtitle: String or element serving as subtitle (support text).
  • subtitleSize: Defines the size of the font used to display the subtitle of the article.
  • subtitleStyle: Specifies the style or styles applied to the text in the subtitle of the item.
  • subtitleFont: Specifies the font of the text of subtitle the item.
  • subtitleColor: Specifies the color of the text of subtitle the item.
  • subtitleAlign: Specifies the align applied to the text in the subtitle of the item.
  • icon: A string with the name of the icon to display on the action button.
  • iconColor: An RGB, HEX color, or a color name. That it will be established as the color of the item's action icon.
  • hilitedIconColor: An RGB, HEX color, or a color name. That it will be established as the color of the item's highlighted action icon.
  • iconSize: An integer to be set as the size of the item's action icon.
  • category: A string used to sort items by category. This is used to create grouping the items.

Compatibility and Support

OS

mac

windows

linux

ios

android

Platforms

desktop

mobile

web